cloneservicecontainers - Ant task

Description

The Ant task cloneservicecontainers clones a list of service containers to the target computer. The list of service containers to be cloned is identified based on the search criteria definition. The search criteria can be defined across the set of organizations and the Shared space. This task can be used to clone the service containers to the same computer or to a different node in a cluster. In the latter case, the task can be executed from any node in a cluster other than the target node.

Prerequisites

Before cloning a Collaborative Workspace (CWS) service container to another node, it is assumed that the node-independent configuration settings of the target node match those of the source node. Refer to Collaborative Workspace Service Container Settings for an overview of the CWS service container settings.

Note: For multi-node Process Platform clusters, the CWS synchronization and build folder must be configured on a shared file system. Detailed instructions on how to configure CWS to use a shared file system can be found here.

Sample Usage

A sample usage of the cloneservicecontainers task is below. Click here to download a sample build script.

<cloneservicecontainers containerNameSuffix="UniqueSuffixIdentifier"
    sourceNodeName="serverA" targetNodeName="serverB">
    <searchCriteria>
        <organizations>
            <include>system</include>
            <include>Organization B</include>
            <exclude>Organization C</exclude>
            <exclude>Organization D</exclude>
        </organizations>
        <serviceGroups>
            <include>*</include>
            <exclude>Collaborative Workspace</exclude>
        </serviceGroups>
    </searchCriteria>
</cloneservicecontainers>

Parameters

Attribute	Description	Type	Required
sourceNodeName	Name of the computer from where the configuration of the service containers is read for cloning	String	Yes
targetNodeName	Name of the computer on which the cloned service containers are created	String	Yes
containerNameSuffix	A unique identifier value, which is appended to the name of the existing service containers. If the name of the service container to be cloned is MyContainer and the `containerNameSuffix` value is set to Clone2, then the new name of the cloned service container is MyContainerClone2.	String	Yes

Parameters as nested elements

The Ant task has a set of child elements to define a search criteria. The search criteria enables identification of the set of service containers across the organizations and the Shared space, and cloning them to the target computer.

searchCriteria

This element contains two child elements as defined below:

organizations

This is an optional element. This element has two nested elements: include and exclude. Use the include element to clone the service containers of an organization. To exclude an organization from cloning, add an exclude element with the name of the organization as its value. You can define any number of include and exclude elements. You can also use simple search patterns to filter the list of organizations.

Usage Pattern:

To include all the organizations without any exclusions, remove the searchCriteriaelement:

<cloneservicecontainers containerNameSuffix="UniqueSuffixIdentifier"
    sourceNodeName="serverA" targetNodeName="serverB"/>

To clone all the service containers in Organization A but not in Organization B and C:

<searchCriteria>
    <organizations>
        <include>Organization A</include>
        <exclude>Organization B</exclude>
        <exclude>Organization C</exclude>
    </organizations>
</searchCriteria>

If there are five organizations and you need to clone the service containers only in Organization A, then the search criteria definition below excludes all the other organizations:
```
<searchCriteria>
    <organizations>
        <include>Organization A</include>
    </organizations>
</searchCriteria>
```

To clone the service containers in all the organizations whose name starts with Ame:

<searchCriteria>
    <organizations>
        <include>Ame*</include>
    </organizations>
</searchCriteria>

serviceGroups

This element has two nested elements: include and exclude. Use the include element to add the name of the service groups whose service containers must be cloned. To exclude a service group from cloning, add an exclude element with the name of the service group as its value. You can define any number of include and exclude elements. You can also use simple search patterns to filter the list of service groups.

Note:

The serviceGroups element and its child elements are applicable to all the organizations defined in the searchCriteria filter for the organizations.
If there is more than one service container for a specific service group, cloning is done for all the service containers.
Cloning is skipped if a service container to be cloned already exists in LDAP.
If there is an OS Process configured for a service container to be cloned to a target node, the corresponding OS Process is created on the target node if it does not exist.
The Monitor service container is not cloned.
If you have service groups with simpleFailover as the routing algorithm and clone the service containers associated to them, the cloned service containers will have the same preference values. System Administrator must review the preference values and assign values accordingly using the System Resource Manager.

Usage Pattern:

If the name of the service group is defined as 'Business Process Management' to clone the corresponding service container:
```
<include>Business Process Management</include>
```
Remove the serviceGroups element to include all the service groups without any exclusions.

Note: The cloning of LDAP Service through the Ant task is not supported. It is recommended to perform it manually through the System Resource Manager. Refer to the Process Platform High Availability Configuration Guide for more information on the manual steps.

Supported Search Patterns

Note: These search patterns are case-sensitive.

Pattern	Description
*	Any string
system*	Any string beginning with 'system'
*system	Any string ending with 'system'
system	Exact name

pp108 : cloneservicecontainers - Ant task